<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>QuantumLibrary: /bb/mbigc/mbig5696/git/quantum_external/src/quantum_yielding_thread.h Source File</title>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../jquery.js"></script>
<script type="text/javascript" src="../../dynsections.js"></script>
<link href="../../navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../resize.js"></script>
<script type="text/javascript" src="../../navtreedata.js"></script>
<script type="text/javascript" src="../../navtree.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
  $(document).ready(initResizable);
/* @license-end */</script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="../../search/searchdata.js"></script>
<script type="text/javascript" src="../../search/search.js"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">QuantumLibrary
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="../../menudata.js"></script>
<script type="text/javascript" src="../../menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
$(document).ready(function(){initNavTree('d0/dbc/quantum__yielding__thread_8h_source.html','../../');});
/* @license-end */
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="headertitle">
<div class="title">quantum_yielding_thread.h</div>  </div>
</div><!--header-->
<div class="contents">
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno">    1</span>&#160;<span class="comment">/*</span></div><div class="line"><a name="l00002"></a><span class="lineno">    2</span>&#160;<span class="comment">** Copyright 2018 Bloomberg Finance L.P.</span></div><div class="line"><a name="l00003"></a><span class="lineno">    3</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00004"></a><span class="lineno">    4</span>&#160;<span class="comment">** Licensed under the Apache License, Version 2.0 (the &quot;License&quot;);</span></div><div class="line"><a name="l00005"></a><span class="lineno">    5</span>&#160;<span class="comment">** you may not use this file except in compliance with the License.</span></div><div class="line"><a name="l00006"></a><span class="lineno">    6</span>&#160;<span class="comment">** You may obtain a copy of the License at</span></div><div class="line"><a name="l00007"></a><span class="lineno">    7</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00008"></a><span class="lineno">    8</span>&#160;<span class="comment">**     http://www.apache.org/licenses/LICENSE-2.0</span></div><div class="line"><a name="l00009"></a><span class="lineno">    9</span>&#160;<span class="comment">**</span></div><div class="line"><a name="l00010"></a><span class="lineno">   10</span>&#160;<span class="comment">** Unless required by applicable law or agreed to in writing, software</span></div><div class="line"><a name="l00011"></a><span class="lineno">   11</span>&#160;<span class="comment">** distributed under the License is distributed on an &quot;AS IS&quot; BASIS,</span></div><div class="line"><a name="l00012"></a><span class="lineno">   12</span>&#160;<span class="comment">** WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span></div><div class="line"><a name="l00013"></a><span class="lineno">   13</span>&#160;<span class="comment">** See the License for the specific language governing permissions and</span></div><div class="line"><a name="l00014"></a><span class="lineno">   14</span>&#160;<span class="comment">** limitations under the License.</span></div><div class="line"><a name="l00015"></a><span class="lineno">   15</span>&#160;<span class="comment">*/</span></div><div class="line"><a name="l00016"></a><span class="lineno">   16</span>&#160;<span class="preprocessor">#ifndef BLOOMBERG_QUANTUM_YIELDING_THREAD_H</span></div><div class="line"><a name="l00017"></a><span class="lineno">   17</span>&#160;<span class="preprocessor">#define BLOOMBERG_QUANTUM_YIELDING_THREAD_H</span></div><div class="line"><a name="l00018"></a><span class="lineno">   18</span>&#160;</div><div class="line"><a name="l00019"></a><span class="lineno">   19</span>&#160;<span class="preprocessor">#include &lt;thread&gt;</span></div><div class="line"><a name="l00020"></a><span class="lineno">   20</span>&#160;<span class="preprocessor">#include &lt;chrono&gt;</span></div><div class="line"><a name="l00021"></a><span class="lineno">   21</span>&#160;<span class="preprocessor">#include &lt;quantum/quantum_thread_traits.h&gt;</span></div><div class="line"><a name="l00022"></a><span class="lineno">   22</span>&#160;</div><div class="line"><a name="l00023"></a><span class="lineno">   23</span>&#160;<span class="keyword">namespace </span><a class="code" href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a> {</div><div class="line"><a name="l00024"></a><span class="lineno">   24</span>&#160;<span class="keyword">namespace </span>quantum {</div><div class="line"><a name="l00025"></a><span class="lineno">   25</span>&#160;</div><div class="line"><a name="l00026"></a><span class="lineno">   26</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00027"></a><span class="lineno">   27</span>&#160;<span class="comment">//                               struct YieldingThreadDuration</span></div><div class="line"><a name="l00028"></a><span class="lineno">   28</span>&#160;<span class="comment">//==============================================================================================</span></div><div class="line"><a name="l00032"></a><span class="lineno">   32</span>&#160;<span class="comment"></span><span class="keyword">template</span> &lt;<span class="keyword">class</span> DURATION&gt;</div><div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html">   33</a></span>&#160;<span class="keyword">struct </span><a class="code" href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html">YieldingThreadDuration</a></div><div class="line"><a name="l00034"></a><span class="lineno">   34</span>&#160;{</div><div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html#a4cffdc6f24552ae052097d488ee900fa">   38</a></span>&#160;    <span class="keywordtype">void</span> <a class="code" href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html#a4cffdc6f24552ae052097d488ee900fa">operator()</a>(DURATION time = <a class="code" href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html#a99b66461fbc35c18df6f1609947000e7">defaultDuration</a>())</div><div class="line"><a name="l00039"></a><span class="lineno">   39</span>&#160;    {</div><div class="line"><a name="l00040"></a><span class="lineno">   40</span>&#160;        <span class="keywordflow">if</span> (time == DURATION(0)) {</div><div class="line"><a name="l00041"></a><span class="lineno">   41</span>&#160;            <span class="comment">//Busy wait</span></div><div class="line"><a name="l00042"></a><span class="lineno">   42</span>&#160;            std::this_thread::yield();</div><div class="line"><a name="l00043"></a><span class="lineno">   43</span>&#160;        }</div><div class="line"><a name="l00044"></a><span class="lineno">   44</span>&#160;        <span class="keywordflow">else</span> {</div><div class="line"><a name="l00045"></a><span class="lineno">   45</span>&#160;            <span class="comment">//Sleep wait</span></div><div class="line"><a name="l00046"></a><span class="lineno">   46</span>&#160;            std::this_thread::sleep_for(time);</div><div class="line"><a name="l00047"></a><span class="lineno">   47</span>&#160;        }</div><div class="line"><a name="l00048"></a><span class="lineno">   48</span>&#160;    }</div><div class="line"><a name="l00049"></a><span class="lineno">   49</span>&#160;    </div><div class="line"><a name="l00050"></a><span class="lineno"><a class="line" href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html#a99b66461fbc35c18df6f1609947000e7">   50</a></span>&#160;    <span class="keyword">static</span> DURATION <a class="code" href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html#a99b66461fbc35c18df6f1609947000e7">defaultDuration</a>()</div><div class="line"><a name="l00051"></a><span class="lineno">   51</span>&#160;    {</div><div class="line"><a name="l00052"></a><span class="lineno">   52</span>&#160;        <span class="keywordflow">return</span> std::chrono::duration_cast&lt;DURATION&gt;(<a class="code" href="../../d8/daf/structBloomberg_1_1quantum_1_1ThreadTraits.html#a4b2bf253a6038965f61090f83e4725a9">ThreadTraits::yieldSleepIntervalMs</a>()) +</div><div class="line"><a name="l00053"></a><span class="lineno">   53</span>&#160;               std::chrono::duration_cast&lt;DURATION&gt;(<a class="code" href="../../d8/daf/structBloomberg_1_1quantum_1_1ThreadTraits.html#a8f9279b16748742d9451904dfe988cda">ThreadTraits::yieldSleepIntervalUs</a>());</div><div class="line"><a name="l00054"></a><span class="lineno">   54</span>&#160;    }</div><div class="line"><a name="l00055"></a><span class="lineno">   55</span>&#160;};</div><div class="line"><a name="l00056"></a><span class="lineno">   56</span>&#160;</div><div class="line"><a name="l00057"></a><span class="lineno"><a class="line" href="../../dc/d48/namespaceBloomberg_1_1quantum.html#ab4861ce4c0d0ece44adc70e68ff02131">   57</a></span>&#160;<span class="keyword">using</span> <a class="code" href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html">YieldingThread</a> = <a class="code" href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html">YieldingThreadDuration&lt;std::chrono::microseconds&gt;</a>;</div><div class="line"><a name="l00058"></a><span class="lineno">   58</span>&#160;</div><div class="line"><a name="l00059"></a><span class="lineno">   59</span>&#160;}}</div><div class="line"><a name="l00060"></a><span class="lineno">   60</span>&#160;</div><div class="line"><a name="l00061"></a><span class="lineno">   61</span>&#160;<span class="preprocessor">#endif //BLOOMBERG_QUANTUM_YIELDING_THREAD_H</span></div><div class="ttc" id="namespaceBloomberg_html"><div class="ttname"><a href="../../d6/db9/namespaceBloomberg.html">Bloomberg</a></div><div class="ttdef"><b>Definition:</b> quantum_buffer_impl.h:22</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1ThreadTraits_html_a8f9279b16748742d9451904dfe988cda"><div class="ttname"><a href="../../d8/daf/structBloomberg_1_1quantum_1_1ThreadTraits.html#a8f9279b16748742d9451904dfe988cda">Bloomberg::quantum::ThreadTraits::yieldSleepIntervalUs</a></div><div class="ttdeci">static std::chrono::microseconds &amp; yieldSleepIntervalUs()</div><div class="ttdef"><b>Definition:</b> quantum_thread_traits.h:42</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1ThreadTraits_html_a4b2bf253a6038965f61090f83e4725a9"><div class="ttname"><a href="../../d8/daf/structBloomberg_1_1quantum_1_1ThreadTraits.html#a4b2bf253a6038965f61090f83e4725a9">Bloomberg::quantum::ThreadTraits::yieldSleepIntervalMs</a></div><div class="ttdeci">static std::chrono::milliseconds &amp; yieldSleepIntervalMs()</div><div class="ttdoc">Dictates how long any thread should sleep on blocking calls when interacting with coroutines (e....</div><div class="ttdef"><b>Definition:</b> quantum_thread_traits.h:37</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1YieldingThreadDuration_html_a99b66461fbc35c18df6f1609947000e7"><div class="ttname"><a href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html#a99b66461fbc35c18df6f1609947000e7">Bloomberg::quantum::YieldingThreadDuration::defaultDuration</a></div><div class="ttdeci">static DURATION defaultDuration()</div><div class="ttdef"><b>Definition:</b> quantum_yielding_thread.h:50</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1YieldingThreadDuration_html_a4cffdc6f24552ae052097d488ee900fa"><div class="ttname"><a href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html#a4cffdc6f24552ae052097d488ee900fa">Bloomberg::quantum::YieldingThreadDuration::operator()</a></div><div class="ttdeci">void operator()(DURATION time=defaultDuration())</div><div class="ttdoc">Yields the current thread either via a busy wait loop or by sleeping it. Behavior is determined at co...</div><div class="ttdef"><b>Definition:</b> quantum_yielding_thread.h:38</div></div>
<div class="ttc" id="structBloomberg_1_1quantum_1_1YieldingThreadDuration_html"><div class="ttname"><a href="../../dd/d4a/structBloomberg_1_1quantum_1_1YieldingThreadDuration.html">Bloomberg::quantum::YieldingThreadDuration</a></div><div class="ttdoc">This class provides the same functionality as a coroutine yield when called from a thread context.</div><div class="ttdef"><b>Definition:</b> quantum_yielding_thread.h:33</div></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="../../dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><b>quantum_yielding_thread.h</b></li>
    <li class="footer">Generated by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="../../doxygen.png" alt="doxygen"/></a> 1.8.15 </li>
  </ul>
</div>
</body>
</html>
